Generate one-page CLI reference document #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
javisperez
approved these changes
Mar 5, 2024
gorkem
approved these changes
Mar 5, 2024
amisevsk
force-pushed
the
gen-one-page-cli-doc
branch
from
4597169 to
414d5c4
Compare
Add script docs/src/docs/cli/generate.sh to generate a one-page CLI reference document rather than a markdown file per CLI command. This file is formed by concatenating per-command markdown docs with the "See also" section stripped. The top-level introduction for the document can be customized via the cli-reference-header.md file.
amisevsk
force-pushed
the
gen-one-page-cli-doc
branch
2 times, most recently
from
0ffd736 to
0cd6990
Compare
Add PR check to block merging changes with trailing whitespace on lines. Check skips binary files, svg files, and anything within the docs/ directory.
By default, go build is outputting a file named kitops, which is untracked in the repository. This breaks later PR checks that check for autogenerated files, etc. since it makes the repository state dirty.
amisevsk
force-pushed
the
gen-one-page-cli-doc
branch
from
0cd6990 to
3611ad5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Instead of generating a markdown file per CLI command, collapse all commands into a single markdown document with customizable front matter (currently, just a heading). With this change, generating CLI reference docs is done by calling
docs/src/docs/cli/generate.sh(which has the added bonus of being callable from anywhere)In addition, add PR checks for
In looking at the diff, you may want to ignore the "trim trailing whitespace" commit, as it litters the changes significantly.